home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 April / EnigmA AMIGA RUN 17 (1997)(G.R. Edizioni)(IT)[!][issue 1997-04][EAR-CD].iso / EARCD / comm / bbs / GetShort.readme < prev    next >
Text File  |  1996-12-07  |  7KB  |  208 lines
  1. Short:    Grabs short descriptions from readmes.
  2. Author:   CAT
  3. Uploader: hoss@satech.net.au (Ian Hoskins)
  4. Type:     comm/bbs
  5.  
  6. My.  I've released a bit of code (?!?) .
  7.  
  8.                   Get Short v1
  9.                 ================
  10. *    Disclaimer
  11.  
  12. Yup, the usual stuff here, if my program doesn't work, doesn't work properly,
  13. damages a disk, ruins files, blows up your mother, well, frankly, I don't care.
  14. You can't blame me.  However if your Mum does blow up cuz of my program, I'd
  15. really like to hear about it.  And any bugs you come accross.  And any
  16. improvements you can think of, altho for a program like this, there really
  17. isn't much else you could want it to do.
  18.  
  19. *    Why GetShort?
  20.  
  21. A friend of mine is constantly uploading files grabbed from AmiNet to a local
  22. BBS, I was always amazed at how he got the descriptions to sound so, well,
  23. professional.
  24.  
  25. He isn't usually much of a serious character, and on many descriptions he
  26. didn't even leave a smiley face :)
  27.  
  28. The other day, I find out that he grabs the short descriptions from each
  29. readme file one by one, and shoves them in the comment line to each archive,
  30. and moves them to the Uploads/ directory.  All by hand.
  31.  
  32. I admire this quality of his, it's called patience, and I could never keep it
  33. up :)
  34.  
  35. Anyway, I ask him if he'd like me to make him a program to do half the work
  36. for him, and he says yes, so this is where GetShort comes in.
  37.  
  38. This program is dedicated to all those who have mass-uploaded files from
  39. AmiNet to FREDs BBS.  It's really appreciated.
  40.  
  41. Excuse the shockingness of this docfile.  If you don't understand what I'm
  42. babbling about, well just run the program and figure it out yourself.  It
  43. really isn't complicated.
  44.  
  45. *    How do I run it?
  46.  
  47. Either double click it's icon or type in it's filename from CLI.
  48.  
  49. You need ReqTools.library.
  50.  
  51. It doesn't support tooltypes or cli arguments.
  52.  
  53. *    What does it do?
  54.  
  55. OK first it asks you how long the description length will be.  This is so
  56.  
  57. 1)  The program knows when to stop if it doesn't encounter a `return'
  58.     character
  59. 2)  For BBS programs that allow only one line of text (ie Maxs BBS).
  60.  
  61. If it encounters more text after the max length you set, it will put in the
  62. short description a nice "..." at the end, to signify that the description
  63. got cut off.
  64.  
  65. The default value is 70 characters.
  66.  
  67. ***BUGS***  Well, the default value SHOULD be 70 characters.  On my A500
  68.     it's the memory address where a variable or library base is held.
  69.     Umm.  I don't know why, but I put it down to another Blitz bug :)
  70.     The defaultvalue function used to work on the 1200, but I can't test
  71.     it cuz it's in for repairs :)
  72.  
  73. Anyway, after that, it brings up a groovey ReqTools loadfile requestor,
  74. suggesting you to select the readme files you want to have GetShorted.
  75.  
  76. You can select any number of files by holding down a shift key when you click
  77. on them.
  78.  
  79. You can click Cancel here to Quit.
  80.  
  81. So you've selected your files.
  82.  
  83. Let's say the first one is named JuicyFruit.readme.
  84.  
  85. Don't ask me why :)
  86.  
  87. The program then goes and locates the first file, grabs any Short: description
  88. it finds (in case someone writes a doc in the wrong order) and shoves it in a
  89. file named JuicyFruit.short.  Note that at the moment the extension changing
  90. routine isn't very smart, and if you select a file named Bonkawillietoottoot,
  91. the outputted filename is Bonkawillietoshort.
  92.  
  93. Maybe I'll make it smarter later, but I really don't see the point, as AmiNet
  94. readme's have to be named .readme anyway.  Well, they're supposed to.
  95.  
  96. Now.  Say you use NComm (the best!).
  97.  
  98. Instead of typing the description for the file you just ASCII Upload it.
  99.  
  100. 70 character descriptions should fit quite nicely on Maxs BBS filelistings.
  101.  
  102. Anyway, when GetShort has finished all the files, it'll tell you, and you get
  103. the choice to select some more or quit out.
  104.  
  105. There are a number of error messages that could come up, but you shouldn't see
  106. them often and when you do, I'm sure you'll work out what exactly went wrong
  107. and how to fix it.
  108.  
  109. *    Requirements:
  110.  
  111. Well, you first up need ReqTools.library.  You MAY need Kickstart 2.  But you
  112. shouldn't.  And well, the program eats up about 32k of memory, and everybody
  113. has that.  So no probs there.
  114.  
  115. *    Bugs
  116.  
  117. It wouldn't suprise me if it doesn't work on your A4000/060/2chip/32fast/
  118. hardwarehacked/remotecontrolkeyboardsupport, but nevertheless, it should.
  119.  
  120. The default description length value may be a little larger than 70.
  121.  
  122. If it is, then for god sakes tell me and I'll take the default value out.
  123.  
  124. I think it should work on a kickstart 3.0 or '020 machine perfectly.
  125.  
  126. If you give GetShort a file that doesn't have a Short: description, it will do
  127. one of two things:
  128.  
  129. 1)  Go to the next file
  130. 2)  Grab a random piece of the file and decide that that looks like the
  131.     description.  No, really.  I ran it through the Readme file for
  132.     OctaMED Soundstudio.  This is what it came up with:
  133.  
  134.     ing OctaMED! This file contains important information, so...
  135.  
  136.     It's a really good description for that file.  Trust me.  :)
  137.  
  138. Why does it do that?  I don't know.  And I don't care.  You shouldn't be
  139. running this program on all your files in the C: directory anyway :)
  140.  
  141. If you want to test my program, run it through this readme file, and it
  142. *should* select the line at the very top.  No, it will.  I hope.
  143.  
  144. *    Contact me!
  145.  
  146. This program is considered to be IWantLotsOfMoneyware.  If you like it and use
  147. it a lot, then send me at least $AUS10.  You won't get a registered version, or
  148. a copy of my next util, if I release one, or a poster, or anything like that.
  149.  
  150. If you're lucky you'll get a message saying thanks <grin>
  151.  
  152. If you want to just tell me how bad my code is, then contact me at this
  153. address:
  154.  
  155. hoss@satech.net.au    or visit his webpage:
  156.  
  157. http://www.satech.net.au/~hoss/index.html
  158.  
  159. And address it to CAT, or Toby, because it's my friend's email address.
  160.  
  161. *    (C)
  162.  
  163. This program is (C) 1996 Toby Zuijdveld of RESISTANCE.
  164.  
  165. If you use it in a commercially released program without my consent, well,
  166. I won't care but don't do it anyway :)
  167.  
  168. ReqTools is (C) 19xx Nico Francais.
  169.  
  170. Or something.  Don't hurt me for not spelling your name right please :)
  171.  
  172. I think I was right wasn't I?
  173.  
  174. Blitz Basic II is (C) 19xx Acid Software.
  175.  
  176. The ReqTools commands were strung together by Neil O'Rourke.
  177.  
  178. The machine on which I programmed this was originally thankedest to Commodore.
  179.  
  180. Now I don't know who to blame.
  181.  
  182. Urrr what else.  Let's see.  OctaMED got a mention, that's thanks to Teijo
  183. Kinnunen.
  184.  
  185. Hmm.  Out of things to blame people for.  Urr.
  186.  
  187. You can blame Civilization on Sid Meier, and Australia's Choice Anzac Biscuits
  188. on Australia's Choice.  And K-Mart.  Sorta.
  189.  
  190. *    Nothing else to crap on about
  191.  
  192. Yup, This doc file's finished.
  193.  
  194. Now go away.
  195.  
  196. CATChas.
  197.  
  198.  
  199. ============================= Archive contents =============================
  200.  
  201. Original  Packed Ratio    Date     Time    Name
  202. -------- ------- ----- --------- --------  -------------
  203.      351     162 53.8% 22-Apr-91 17:08:56  File_Id.DIZ
  204.     6730    3225 52.0% 22-Apr-91 17:09:34  GetShort.readme
  205.    19584    9464 51.6% 22-Apr-91 15:29:52  GetShort
  206. -------- ------- ----- --------- --------
  207.    26665   12851 51.8% 18-Nov-96 01:10:32   3 files
  208.